vcProductCreatorDistributionMode

vcProductCreatorDistributionMode allows you to define the probability of feeding one or more types of products when a product creator object uses a feed mode of distribution. A distribution feed mode uses entries. Each entry is a distribution mode product line entry object that defines a product type and weighted probability.

See in: Overview

Module: vcProcessModel

Parent: vcObject

Children -

Referenced by: -

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
Interval	vcDistributionProperty	R	Gets the time to wait in seconds between creating products. Returns: vcDistributionProperty: The Real-valued distribution property.
Limit	Integer	RW	Gets or sets the number of products to create. See more Parameters: limit (Integer): The new limit. Must be 0 or greater. Exceptions: ValueError: When limit is less than 0.
ProductEntries	list	R	Gets a list of all currently defined entries.
Properties	vcPropertyContainer	R	Gets a property container containing the properties in the product creator distribution mode.
RandomStream	Integer	RW	Gets or sets the index of the pseudo-random number generator to use when picking the next product type to instantiate. See more Parameters: index (Integer): The new index. It must be in inclusive range of 0-63. Exceptions: ValueError: When the new index is less than 0 or greater than 63.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
createProductEntry	vcDistributionModeProductLineEntry	vcProductType productType, Real probability	Creates a new entry to the distribution mode configuration. See more Parameters: productType (vcProductType): A product type to be assigned to the new entry. Note: Having more than one entry with same product type is allowed but not recommended. probability (Integer): The entry's probability. Must be greater than or equal to zero. Exceptions: ValueError: When the probability is less than 0. Returns: vcDistributionModeProductLineEntry: The newly created entry.
removeProductEntry	None	vcDistributionModeProductLineEntry entry	Deletes the given entry from this configuration. Parameters: entry (vcDistributionModeProductLineEntry): Entry to be deleted.

Events

Learn how to use events here. The events are also inherited from the parent class.

Name	Parameters	Description
OnProductEntriesChanged	vcProductCreatorDistributionMode source	Triggered when the product entries collection content has changed. See more Parameters: source (vcProductCreatorDistributionMode): The collection that changed.